2.3 查询本地用户列表
基本信息
Path： /api/v1/directory/queryEntity
Method： POST
接口描述：
- 查询用户时，需要在include中添加一个user对象，user对象下面放pageSize和pageIndex，并构造相应的条件来查询
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 必须 |
Body
| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| userDirectoryId | string | 必须 | 用户目录ID，默认的本地用户目录ID为1 | 可通过用户目录查询接口获取ID | |
| showAll | number | 非必须 | 1 | 查询所有，1递归查询组织架构下属的所有数据，0只查询直属的数据 | |
| include | object | 必须 | 查询条件 | ||
| ├─user | object | 必须 | 用户的查询条件 | ||
| ├─├─pageSize | number | 非必须 | 20 | 分页大小，每页查询的最大数据量，越大查询时间越长 | |
| ├─├─pageIndex | number | 非必须 | 1 | 页码 | |
| path | string | 非必须 | '/' | 查询条件：组织架构路径，查询某个组织架构下属数据 | |
| searchData | string[] | 非必须 | 查询条件：模糊搜索关键字，仅支持搜索单个值，传入多个值时仅首个值生效 |
请求示例
{
"userDirectoryId": "1",
"showAll": 1,
"path": "/深信服",
"include": {
"user": {
"pageSize": 20,
"pageIndex": 1,
},
},
"searchData": [
"张三"
]
}
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | number | 必须 | 返回码，0 返回成功 | ||
| data | object | 必须 | 报文数据主体 | ||
| ├─ user | object | 必须 | 数据主体 | ||
| ├─├─ count | number | 必须 | 查询结果的数据总数 | ||
| ├─├─ pageCount | number | 必须 | 查询结果的数据总页数 | ||
| ├─├─ pageSize | number | 必须 | 页大小，每页的最大数据数 | ||
| ├─├─ pageIndex | number | 必须 | 页码 | ||
| ├─├─ data | object[] | 必须 | 查询结果数据主体 | ||
| ├─├─├─ id | string | 必须 | 用户ID | ||
| ├─├─├─ name | string | 必须 | 名称 | ||
| ├─├─├─ path | string | 必须 | 所属组路径 | ||
| ├─├─├─ description | string | 必须 | 描述 | ||
| ├─├─├─ phone | string | 必须 | 手机号码 | ||
| ├─├─├─ status | number | 必须 | 启用状态，0禁用，1启用 | ||
| string | 必须 | 电子邮件 | |||
| ├─├─├─ expiredTime | string | 必须 | 过期时间，13位长度的Unix时间戳，'0'表示永不过期 | ||
| ├─├─├─ createdAt | string | 必须 | 创建时间 | ||
| ├─├─├─ updatedAt | string | 必须 | 更新时间 | ||
| ├─├─├─ band | string | 必须 | 群组名称列表字符串，以逗号分隔 | ||
| ├─├─├─ creator | string | 必须 | 创建者 | ||
| ├─├─├─ authCompose | object | 必须 | 认证策略 | ||
| ├─├─├─├─ id | string | 必须 | 策略ID | ||
| ├─├─├─├─ name | string | 必须 | 策略名称 | ||
| ├─├─├─ lastUpdateTime | string | 必须 | 上次更新的时间 | ||
| ├─├─├─ userPolicy | object | 必须 | 用户策略 | ||
| ├─├─├─├─ id | string | 必须 | 策略ID | ||
| ├─├─├─├─ name | string | 必须 | 策略名称 | ||
| msg | string | 必须 | 返回提示信息，与返回码对应 |
返回示例
{
"code": 0,
"data": {
"user": {
"data": [{
"id": "2005fe50-a72e-11eb-a81c-6b82541c2771",
"name": "11",
"path": "/",
"description": "",
"entityType": "user",
"status": 1,
"expiredTime": "0",
"createdAt": "Tue Apr 27 2021 15:56:51 GMT+0800 (Coordinated Universal Time)",
"updatedAt": "Tue Apr 27 2021 15:56:51 GMT+0800 (Coordinated Universal Time)",
"creator": "wsl",
"authCompose": {
"id": "1",
"name": "默认策略"
},
"lastUpdateTime": "Tue Apr 27 2021 15:56:51 GMT+0800 (Coordinated Universal Time)",
"userPolicy": {
"id": "default",
"name": "默认策略"
},
"email": "",
"phone": "",
"domain": "local",
"serverName": "本地用户目录",
"dataType": "localUser",
"band": "",
"roleNames": ""
},
{
"id": "82b7a440-a34b-11eb-8785-719794ff0d82",
"name": "asadas",
"path": "/qqqqqq",
"description": "",
"entityType": "user",
"status": 1,
"expiredTime": "0",
"createdAt": "Thu Apr 22 2021 17:17:07 GMT+0800 (Coordinated Universal Time)",
"updatedAt": "Thu Apr 22 2021 17:28:45 GMT+0800 (Coordinated Universal Time)",
"creator": "zxz",
"authCompose": {
"id": "1",
"name": "默认策略"
},
"lastUpdateTime": "Thu Apr 22 2021 17:28:45 GMT+0800 (Coordinated Universal Time)",
"userPolicy": {
"id": "default",
"name": "默认策略"
},
"email": "",
"phone": "",
"domain": "local",
"serverName": "本地用户目录",
"dataType": "localUser",
"band": "121123",
"roleNames": ""
},
{
"id": "faad6d40-8adc-11eb-aea7-6da7f984c232",
"name": "1212121",
"path": "/qqq",
"description": "1111",
"entityType": "user",
"status": 1,
"expiredTime": "0",
"createdAt": "Mon Mar 22 2021 15:05:26 GMT+0800 (Coordinated Universal Time)",
"updatedAt": "Thu Apr 22 2021 15:39:15 GMT+0800 (Coordinated Universal Time)",
"creator": "ml",
"authCompose": {
"id": "6a27ab40-a112-11eb-8bde-cdfa9732a2d4",
"name": "1"
},
"lastUpdateTime": "Thu Apr 22 2021 15:39:15 GMT+0800 (Coordinated Universal Time)",
"userPolicy": {
"id": "default",
"name": "默认策略"
},
"email": "",
"phone": "",
"domain": "local",
"serverName": "本地用户目录",
"dataType": "localUser",
"band": "121123,2",
"roleNames": ""
}],
"count": 3,
"pageCount": 1,
"pageSize": 20,
"pageIndex": 1
}
},
"msg": "请求成功"
}
错误信息
| 错误提示 | 错误码 |
|---|---|
| 参数检查出错 | 10000001 |
| 操作失败，对象不存在或已被其他管理员删除 | 77200004 |
| 用户目录不存在 | 77200001 |